home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 January: Mac OS SDK / Dev.CD Jan 99 SDK2.toast / Development Kits / TEC 1.4 / Interfaces / UnicodeConverter.h < prev   
Encoding:
C/C++ Source or Header  |  1998-09-25  |  13.1 KB  |  395 lines  |  [TEXT/MPS ]
  1. /*
  2.      File:        UnicodeConverter.h
  3.  
  4.      Contains:    Types, constants, and prototypes for Unicode Converter
  5.  
  6.      Version:    Mac OS 8
  7.  
  8.      Copyright:    © 1994-1998 by Apple Computer, Inc., all rights reserved.
  9.  
  10.  
  11. */
  12. #ifndef __UNICODECONVERTER__
  13. #define __UNICODECONVERTER__
  14.  
  15. #ifndef __MACTYPES__
  16. #include <MacTypes.h>
  17. #endif
  18. #ifndef __TEXTCOMMON__
  19. #include <TextCommon.h>
  20. #endif
  21. #ifndef __MIXEDMODE__
  22. #include <MixedMode.h>
  23. #endif
  24.  
  25.  
  26.  
  27. #if PRAGMA_ONCE
  28. #pragma once
  29. #endif
  30.  
  31. #ifdef __cplusplus
  32. extern "C" {
  33. #endif
  34.  
  35. #if PRAGMA_IMPORT
  36. #pragma import on
  37. #endif
  38.  
  39. #if PRAGMA_STRUCT_ALIGN
  40.     #pragma options align=mac68k
  41. #elif PRAGMA_STRUCT_PACKPUSH
  42.     #pragma pack(push, 2)
  43. #elif PRAGMA_STRUCT_PACK
  44.     #pragma pack(2)
  45. #endif
  46.  
  47. /* Unicode conversion contexts: */
  48. typedef struct OpaqueTextToUnicodeInfo*  TextToUnicodeInfo;
  49. typedef struct OpaqueUnicodeToTextInfo*  UnicodeToTextInfo;
  50. typedef struct OpaqueUnicodeToTextRunInfo*  UnicodeToTextRunInfo;
  51. typedef const TextToUnicodeInfo         ConstTextToUnicodeInfo;
  52. typedef const UnicodeToTextInfo         ConstUnicodeToTextInfo;
  53. /* UnicodeMapVersion type & values */
  54. typedef SInt32                             UnicodeMapVersion;
  55.  
  56. enum {
  57.     kUnicodeUseLatestMapping    = -1,
  58.     kUnicodeUseHFSPlusMapping    = 4
  59. };
  60.  
  61. /* Types used in conversion */
  62.  
  63. struct UnicodeMapping {
  64.     TextEncoding                     unicodeEncoding;
  65.     TextEncoding                     otherEncoding;
  66.     UnicodeMapVersion                 mappingVersion;
  67. };
  68. typedef struct UnicodeMapping            UnicodeMapping;
  69. typedef UnicodeMapping *                UnicodeMappingPtr;
  70.  
  71. typedef const UnicodeMapping *            ConstUnicodeMappingPtr;
  72. /* Control flags for ConvertFromUnicodeToText and ConvertFromTextToUnicode */
  73.  
  74. enum {
  75.     kUnicodeUseFallbacksBit        = 0,
  76.     kUnicodeKeepInfoBit            = 1,
  77.     kUnicodeDirectionalityBits    = 2,
  78.     kUnicodeVerticalFormBit        = 4,
  79.     kUnicodeLooseMappingsBit    = 5,
  80.     kUnicodeStringUnterminatedBit = 6,
  81.     kUnicodeTextRunBit            = 7,
  82.     kUnicodeKeepSameEncodingBit    = 8,
  83.     kUnicodeForceASCIIRangeBit    = 9,
  84.     kUnicodeNoHalfwidthCharsBit    = 10
  85. };
  86.  
  87.  
  88. enum {
  89.     kUnicodeUseFallbacksMask    = 1L << kUnicodeUseFallbacksBit,
  90.     kUnicodeKeepInfoMask        = 1L << kUnicodeKeepInfoBit,
  91.     kUnicodeDirectionalityMask    = 3L << kUnicodeDirectionalityBits,
  92.     kUnicodeVerticalFormMask    = 1L << kUnicodeVerticalFormBit,
  93.     kUnicodeLooseMappingsMask    = 1L << kUnicodeLooseMappingsBit,
  94.     kUnicodeStringUnterminatedMask = 1L << kUnicodeStringUnterminatedBit,
  95.     kUnicodeTextRunMask            = 1L << kUnicodeTextRunBit,
  96.     kUnicodeKeepSameEncodingMask = 1L << kUnicodeKeepSameEncodingBit,
  97.     kUnicodeForceASCIIRangeMask    = 1L << kUnicodeForceASCIIRangeBit,
  98.     kUnicodeNoHalfwidthCharsMask = 1L << kUnicodeNoHalfwidthCharsBit
  99. };
  100.  
  101. /* Values for kUnicodeDirectionality field */
  102.  
  103. enum {
  104.     kUnicodeDefaultDirection    = 0,
  105.     kUnicodeLeftToRight            = 1,
  106.     kUnicodeRightToLeft            = 2
  107. };
  108.  
  109. /* Directionality masks for control flags */
  110.  
  111. enum {
  112.     kUnicodeDefaultDirectionMask = kUnicodeDefaultDirection << kUnicodeDirectionalityBits,
  113.     kUnicodeLeftToRightMask        = kUnicodeLeftToRight << kUnicodeDirectionalityBits,
  114.     kUnicodeRightToLeftMask        = kUnicodeRightToLeft << kUnicodeDirectionalityBits
  115. };
  116.  
  117. /* Control flags for TruncateForUnicodeToText: */
  118. /*
  119.    Now TruncateForUnicodeToText uses control flags from the same set as used by
  120.    ConvertFromTextToUnicode, ConvertFromUnicodeToText, etc., but only
  121.    kUnicodeStringUnterminatedMask is meaningful for TruncateForUnicodeToText.
  122.    
  123.    Previously two special control flags were defined for TruncateForUnicodeToText:
  124.           kUnicodeTextElementSafeBit = 0
  125.           kUnicodeRestartSafeBit = 1
  126.    However, neither of these was implemented.
  127.    Instead of implementing kUnicodeTextElementSafeBit, we now use
  128.    kUnicodeStringUnterminatedMask since it accomplishes the same thing and avoids
  129.    having special flags just for TruncateForUnicodeToText
  130.    Also, kUnicodeRestartSafeBit is unnecessary, since restart-safeness is handled by
  131.    setting kUnicodeKeepInfoBit with ConvertFromUnicodeToText.
  132.    If TruncateForUnicodeToText is called with one or both of the old special control
  133.    flags set (bits 0 or 1), it will not generate a paramErr, but the old bits have no
  134.    effect on its operation.
  135. */
  136.  
  137. /* Filter bits for filter field in QueryUnicodeMappings and CountUnicodeMappings: */
  138.  
  139. enum {
  140.     kUnicodeMatchUnicodeBaseBit    = 0,
  141.     kUnicodeMatchUnicodeVariantBit = 1,
  142.     kUnicodeMatchUnicodeFormatBit = 2,
  143.     kUnicodeMatchOtherBaseBit    = 3,
  144.     kUnicodeMatchOtherVariantBit = 4,
  145.     kUnicodeMatchOtherFormatBit    = 5
  146. };
  147.  
  148.  
  149. enum {
  150.     kUnicodeMatchUnicodeBaseMask = 1L << kUnicodeMatchUnicodeBaseBit,
  151.     kUnicodeMatchUnicodeVariantMask = 1L << kUnicodeMatchUnicodeVariantBit,
  152.     kUnicodeMatchUnicodeFormatMask = 1L << kUnicodeMatchUnicodeFormatBit,
  153.     kUnicodeMatchOtherBaseMask    = 1L << kUnicodeMatchOtherBaseBit,
  154.     kUnicodeMatchOtherVariantMask = 1L << kUnicodeMatchOtherVariantBit,
  155.     kUnicodeMatchOtherFormatMask = 1L << kUnicodeMatchOtherFormatBit
  156. };
  157.  
  158. /* Control flags for SetFallbackUnicodeToText */
  159.  
  160. enum {
  161.     kUnicodeFallbackSequencingBits = 0
  162. };
  163.  
  164.  
  165. enum {
  166.     kUnicodeFallbackSequencingMask = 3L << kUnicodeFallbackSequencingBits
  167. };
  168.  
  169. /* values for kUnicodeFallbackSequencing field */
  170.  
  171. enum {
  172.     kUnicodeFallbackDefaultOnly    = 0L,
  173.     kUnicodeFallbackCustomOnly    = 1L,
  174.     kUnicodeFallbackDefaultFirst = 2L,
  175.     kUnicodeFallbackCustomFirst    = 3L
  176. };
  177.  
  178.  
  179. /* Caller-supplied entry point to a fallback handler */
  180. typedef CALLBACK_API( OSStatus , UnicodeToTextFallbackProcPtr )(UniChar *iSrcUniStr, ByteCount iSrcUniStrLen, ByteCount *oSrcConvLen, TextPtr oDestStr, ByteCount iDestStrLen, ByteCount *oDestConvLen, LogicalAddress iInfoPtr, ConstUnicodeMappingPtr iUnicodeMappingPtr);
  181. typedef STACK_UPP_TYPE(UnicodeToTextFallbackProcPtr)             UnicodeToTextFallbackUPP;
  182. enum { uppUnicodeToTextFallbackProcInfo = 0x003FFFF0 };         /* pascal 4_bytes Func(4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes) */
  183. #define NewUnicodeToTextFallbackProc(userRoutine)                 (UnicodeToTextFallbackUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), uppUnicodeToTextFallbackProcInfo, GetCurrentArchitecture())
  184. #define CallUnicodeToTextFallbackProc(userRoutine, iSrcUniStr, iSrcUniStrLen, oSrcConvLen, oDestStr, iDestStrLen, oDestConvLen, iInfoPtr, iUnicodeMappingPtr)  CALL_EIGHT_PARAMETER_UPP((userRoutine), uppUnicodeToTextFallbackProcInfo, (iSrcUniStr), (iSrcUniStrLen), (oSrcConvLen), (oDestStr), (iDestStrLen), (oDestConvLen), (iInfoPtr), (iUnicodeMappingPtr))
  185. /* Function prototypes */
  186. #if GENERATING68K && !GENERATINGCFM
  187. /*
  188.       Routine to Initialize the Unicode Converter and cleanup once done with it. 
  189.       These routines must be called from Static Library clients.
  190. */
  191. EXTERN_API( OSStatus )
  192. InitializeUnicodeConverter        (StringPtr                 TECFileName);
  193.  
  194. EXTERN_API( void )
  195. TerminateUnicodeConverter        (void);
  196.  
  197. /* Note: the old names (InitializeUnicode, TerminateUnicode) for the above are still exported.*/
  198. #endif  /* GENERATING68K && !GENERATINGCFM */
  199.  
  200. EXTERN_API( OSStatus )
  201. CreateTextToUnicodeInfo            (ConstUnicodeMappingPtr  iUnicodeMapping,
  202.                                  TextToUnicodeInfo *    oTextToUnicodeInfo);
  203.  
  204. EXTERN_API( OSStatus )
  205. CreateTextToUnicodeInfoByEncoding (TextEncoding         iEncoding,
  206.                                  TextToUnicodeInfo *    oTextToUnicodeInfo);
  207.  
  208. EXTERN_API( OSStatus )
  209. CreateUnicodeToTextInfo            (ConstUnicodeMappingPtr  iUnicodeMapping,
  210.                                  UnicodeToTextInfo *    oUnicodeToTextInfo);
  211.  
  212. EXTERN_API( OSStatus )
  213. CreateUnicodeToTextInfoByEncoding (TextEncoding         iEncoding,
  214.                                  UnicodeToTextInfo *    oUnicodeToTextInfo);
  215.  
  216. EXTERN_API( OSStatus )
  217. CreateUnicodeToTextRunInfo        (ItemCount                 iNumberOfMappings,
  218.                                  const UnicodeMapping     iUnicodeMappings[],
  219.                                  UnicodeToTextRunInfo *    oUnicodeToTextInfo);
  220.  
  221. EXTERN_API( OSStatus )
  222. CreateUnicodeToTextRunInfoByEncoding (ItemCount         iNumberOfEncodings,
  223.                                  const TextEncoding     iEncodings[],
  224.                                  UnicodeToTextRunInfo *    oUnicodeToTextInfo);
  225.  
  226. EXTERN_API( OSStatus )
  227. CreateUnicodeToTextRunInfoByScriptCode (ItemCount         iNumberOfScriptCodes,
  228.                                  const ScriptCode         iScripts[],
  229.                                  UnicodeToTextRunInfo *    oUnicodeToTextInfo);
  230.  
  231. /* Change the TextToUnicodeInfo to another mapping. */
  232. EXTERN_API( OSStatus )
  233. ChangeTextToUnicodeInfo            (TextToUnicodeInfo         ioTextToUnicodeInfo,
  234.                                  ConstUnicodeMappingPtr  iUnicodeMapping);
  235.  
  236. /* Change the UnicodeToTextInfo to another mapping. */
  237. EXTERN_API( OSStatus )
  238. ChangeUnicodeToTextInfo            (UnicodeToTextInfo         ioUnicodeToTextInfo,
  239.                                  ConstUnicodeMappingPtr  iUnicodeMapping);
  240.  
  241.  
  242. EXTERN_API( OSStatus )
  243. DisposeTextToUnicodeInfo        (TextToUnicodeInfo *    ioTextToUnicodeInfo);
  244.  
  245. EXTERN_API( OSStatus )
  246. DisposeUnicodeToTextInfo        (UnicodeToTextInfo *    ioUnicodeToTextInfo);
  247.  
  248. EXTERN_API( OSStatus )
  249. DisposeUnicodeToTextRunInfo        (UnicodeToTextRunInfo *    ioUnicodeToTextRunInfo);
  250.  
  251. EXTERN_API( OSStatus )
  252. ConvertFromTextToUnicode        (TextToUnicodeInfo         iTextToUnicodeInfo,
  253.                                  ByteCount                 iSourceLen,
  254.                                  ConstLogicalAddress     iSourceStr,
  255.                                  OptionBits             iControlFlags,
  256.                                  ItemCount                 iOffsetCount,
  257.                                  ByteOffset             iOffsetArray[],
  258.                                  ItemCount *            oOffsetCount,
  259.                                  ByteOffset             oOffsetArray[],
  260.                                  ByteCount                 iOutputBufLen,
  261.                                  ByteCount *            oSourceRead,
  262.                                  ByteCount *            oUnicodeLen,
  263.                                  UniCharArrayPtr         oUnicodeStr);
  264.  
  265. EXTERN_API( OSStatus )
  266. ConvertFromUnicodeToText        (UnicodeToTextInfo         iUnicodeToTextInfo,
  267.                                  ByteCount                 iUnicodeLen,
  268.                                  ConstUniCharArrayPtr     iUnicodeStr,
  269.                                  OptionBits             iControlFlags,
  270.                                  ItemCount                 iOffsetCount,
  271.                                  ByteOffset             iOffsetArray[],
  272.                                  ItemCount *            oOffsetCount,
  273.                                  ByteOffset             oOffsetArray[],
  274.                                  ByteCount                 iOutputBufLen,
  275.                                  ByteCount *            oInputRead,
  276.                                  ByteCount *            oOutputLen,
  277.                                  LogicalAddress         oOutputStr);
  278.  
  279. EXTERN_API( OSStatus )
  280. ConvertFromUnicodeToTextRun        (UnicodeToTextRunInfo     iUnicodeToTextInfo,
  281.                                  ByteCount                 iUnicodeLen,
  282.                                  ConstUniCharArrayPtr     iUnicodeStr,
  283.                                  OptionBits             iControlFlags,
  284.                                  ItemCount                 iOffsetCount,
  285.                                  ByteOffset             iOffsetArray[],
  286.                                  ItemCount *            oOffsetCount,
  287.                                  ByteOffset             oOffsetArray[],
  288.                                  ByteCount                 iOutputBufLen,
  289.                                  ByteCount *            oInputRead,
  290.                                  ByteCount *            oOutputLen,
  291.                                  LogicalAddress         oOutputStr,
  292.                                  ItemCount                 iEncodingRunBufLen,
  293.                                  ItemCount *            oEncodingRunOutLen,
  294.                                  TextEncodingRun         oEncodingRuns[]);
  295.  
  296. EXTERN_API( OSStatus )
  297. ConvertFromUnicodeToScriptCodeRun (UnicodeToTextRunInfo  iUnicodeToTextInfo,
  298.                                  ByteCount                 iUnicodeLen,
  299.                                  ConstUniCharArrayPtr     iUnicodeStr,
  300.                                  OptionBits             iControlFlags,
  301.                                  ItemCount                 iOffsetCount,
  302.                                  ByteOffset             iOffsetArray[],
  303.                                  ItemCount *            oOffsetCount,
  304.                                  ByteOffset             oOffsetArray[],
  305.                                  ByteCount                 iOutputBufLen,
  306.                                  ByteCount *            oInputRead,
  307.                                  ByteCount *            oOutputLen,
  308.                                  LogicalAddress         oOutputStr,
  309.                                  ItemCount                 iScriptRunBufLen,
  310.                                  ItemCount *            oScriptRunOutLen,
  311.                                  ScriptCodeRun             oScriptCodeRuns[]);
  312.  
  313. /* Truncate a multibyte string at a safe place. */
  314. EXTERN_API( OSStatus )
  315. TruncateForTextToUnicode        (ConstTextToUnicodeInfo  iTextToUnicodeInfo,
  316.                                  ByteCount                 iSourceLen,
  317.                                  ConstLogicalAddress     iSourceStr,
  318.                                  ByteCount                 iMaxLen,
  319.                                  ByteCount *            oTruncatedLen);
  320.  
  321. /* Truncate a Unicode string at a safe place. */
  322. EXTERN_API( OSStatus )
  323. TruncateForUnicodeToText        (ConstUnicodeToTextInfo  iUnicodeToTextInfo,
  324.                                  ByteCount                 iSourceLen,
  325.                                  ConstUniCharArrayPtr     iSourceStr,
  326.                                  OptionBits             iControlFlags,
  327.                                  ByteCount                 iMaxLen,
  328.                                  ByteCount *            oTruncatedLen);
  329.  
  330. /* Convert a Pascal string to Unicode string. */
  331. EXTERN_API( OSStatus )
  332. ConvertFromPStringToUnicode        (TextToUnicodeInfo         iTextToUnicodeInfo,
  333.                                  ConstStr255Param         iPascalStr,
  334.                                  ByteCount                 iOutputBufLen,
  335.                                  ByteCount *            oUnicodeLen,
  336.                                  UniCharArrayPtr         oUnicodeStr);
  337.  
  338. /* Convert a Unicode string to Pascal string. */
  339. EXTERN_API( OSStatus )
  340. ConvertFromUnicodeToPString        (UnicodeToTextInfo         iUnicodeToTextInfo,
  341.                                  ByteCount                 iUnicodeLen,
  342.                                  ConstUniCharArrayPtr     iUnicodeStr,
  343.                                  Str255                 oPascalStr);
  344.  
  345. /* Count the available conversion mappings. */
  346. EXTERN_API( OSStatus )
  347. CountUnicodeMappings            (OptionBits             iFilter,
  348.                                  ConstUnicodeMappingPtr  iFindMapping,
  349.                                  ItemCount *            oActualCount);
  350.  
  351. /* Get a list of the available conversion mappings. */
  352. EXTERN_API( OSStatus )
  353. QueryUnicodeMappings            (OptionBits             iFilter,
  354.                                  ConstUnicodeMappingPtr  iFindMapping,
  355.                                  ItemCount                 iMaxCount,
  356.                                  ItemCount *            oActualCount,
  357.                                  UnicodeMapping         oReturnedMappings[]);
  358.  
  359. /* Setup the fallback handler for converting Unicode To Text. */
  360. EXTERN_API( OSStatus )
  361. SetFallbackUnicodeToText        (UnicodeToTextInfo         iUnicodeToTextInfo,
  362.                                  UnicodeToTextFallbackUPP  iFallback,
  363.                                  OptionBits             iControlFlags,
  364.                                  LogicalAddress         iInfoPtr);
  365.  
  366. /* Setup the fallback handler for converting Unicode To TextRuns. */
  367. EXTERN_API( OSStatus )
  368. SetFallbackUnicodeToTextRun        (UnicodeToTextRunInfo     iUnicodeToTextRunInfo,
  369.                                  UnicodeToTextFallbackUPP  iFallback,
  370.                                  OptionBits             iControlFlags,
  371.                                  LogicalAddress         iInfoPtr);
  372.  
  373.  
  374.  
  375. #if PRAGMA_STRUCT_ALIGN
  376.     #pragma options align=reset
  377. #elif PRAGMA_STRUCT_PACKPUSH
  378.     #pragma pack(pop)
  379. #elif PRAGMA_STRUCT_PACK
  380.     #pragma pack()
  381. #endif
  382.  
  383. #ifdef PRAGMA_IMPORT_OFF
  384. #pragma import off
  385. #elif PRAGMA_IMPORT
  386. #pragma import reset
  387. #endif
  388.  
  389. #ifdef __cplusplus
  390. }
  391. #endif
  392.  
  393. #endif /* __UNICODECONVERTER__ */
  394.  
  395.